BBS Toolkit/BBS Toolkit.iso/doors_1/faxdor17.zip/ECHOFAX.DOC

Text File | 1992-10-18 | 31KB | 700 lines

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────









  ═══════════════════════════════════════════════════════════════════════════=

                         EchoFax Event Utility

               FAX Service for PCBoard 14.x Message Bases

                       $20.00 to purchase EchoFax
                      $10.00 to Register Fax-Door

                                   or

                    $25.00 to purchase both Products

              Written by: Gerry Freymann
                          P.O. Box 1226
                          Cobourg, Ontario
                          K9A 5A4

          The Phantom BBS [phone] USR HST Dual Standard
                          [phone] 19200 USR HST


  ═══════════════════════════════════════════════════════════════════════════=






















  ────────────────────────────────────────────────────────────────────────────
  Page 1

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

  ┌─────────────────────────────────────────────────────────────────────────┐
  │                        Warranty and Liability                           │
  └─────────────────────────────────────────────────────────────────────────┘

  I retain the Copyright to this program.  You are NOT allowed to make
  changes to the compiled .EXE files without the expressed written consent
  of Gerry Freymann.  I work hard creating these programs and don't
  appreciate having my work altered.

  I will NOT be held responsible for the use and/or misuse of this program.
  If you decide to run this program on your system you do so at your own
  risk.

  PCBoard is a trademark of Clark Development Company.
  Bitfax is a trademark of Bit Software, Inc.

  ┌────────────────────────────────────────────────────────────────────────┐
  │                         EchoFax Requirements                           │
  └────────────────────────────────────────────────────────────────────────┘

  First of all, EchoFax may not be for everybody.  There are a few
  requirements you should be aware of, that may make this utility unsuitable
  for some Bulletin Board Systems:

  - You'll need room in your computer for an internal Fax-Card.  That not only
  means physical space, but also free interupts and com ports.

  - You need an extra phone line that can be dedicated or a phone line that
  can be properly time shared with the fax card.

  - You need a Fax board that uses the BitFax software (C) 1989 BIT Software,
  Inc.  All Rights Reserved.  I have used BitFax v.2.061 and 2.062
  successfully.  I have reports that v3 works as well.

  - EchoFax assumes a local call is 7 or 5 digits in length (minus brackets &
  dashes).  If you are in a location where a local call is more, than you'll
  need a customized version.  Please contact me and provide details and we
  can get you set up.  Example local call:  3721625 or 21625

  - EchoFax also assumes that a long distance call is 8 or 11 digits in length
  (minus brackets and dashes).  Again, if this a problem in your location
  please contact me and we can get you set up with a customized version.
  Example long distance call:  14163721625 or 13721625

  - EchoFax will ignore any phone number 4 digits or less, 6, 9 or 10 digits
  or 12 and great and report these as invalid numbers.  If this is a problem
  for you please contact me.

  - Since this program is written in Turbo Basic file sharing is not
  supported.  This will create problems if somebody else is accessing
  the message base at the same time EchoFax wishes to scan for outgoing

  ────────────────────────────────────────────────────────────────────────────
  Page 2

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

  fax messages.  EchoFax will retry, once per second, for up to 30
  consecutive seconds, but I cannot guarantee success if your system is
  up and running.


  ┌─────────────────────────────────────────────────────────────────────────┐
  │                         Overview of EchoFax                             │
  └─────────────────────────────────────────────────────────────────────────┘

  EchoFax was written to provide a simple method of scanning a PCBoard
  14.x message base for outgoing Fax messages.  All you require is a
  Fax card and BitFax software.  How often you decide to scan for outgoing
  fax messages is up to you.  You can call up EchoFax in your $$LOGOFF.BAT
  or include it in your BOARD.BAT using ERRORLEVEL checking to run it
  from DOS without PCBoard in memory.  Your imagination is the only limit!
  If you are running a multi node PCBoard system you only need one copy of
  EchoFax and one Faxboard.. just have the node with the fax card set up
  to scan your message bases when you want!


  ┌─────────────────────────────────────────────────────────────────────────┐
  │                         Features of EchoFax                             │
  └─────────────────────────────────────────────────────────────────────────┘

  ■ Allows you to define a list of Long Distance numbers which any user can
    fax to at no charge to the User.  See NUMBERS.FRE

  ■ Allows you to define a list of User Names who are allowed to fax to Long
    Distance numbers whenever they wish.  See USERS.FRE

  ■ EchoFax ensures full pages are transmitted by automatically adding enough
    blank lines to fill out a page where needed.  Bitfax, under normal
    circumstances varies the page lengths depending on how many lines are
    in your document.

  ■ I have chosen to verify each fax by reading the LOG file created by
    Bitfax.  EchoFax, by default, will read BITFAXTX.LOG but if your copy
    uses BITFAX.LOG you can add a command line switch to force EchoFax to
    use a different LOG file.  See COMMAND LINE SWITCHES

  ■ EchoFax automatically enters messages to the sender of a fax advising
    the user of the status of his/her fax transmission.

  ■ Full Event Logging for debugging purposes.  EchoFax places comments in
    a log file so you can keep watch over its activity.  See ECHOFAX.LOG

  ■ Free MSGFLAG utility!  This utility will make messages private or public
    on ALL messages or messages To & From a specific user of your choice.
    See MSGFLAG.EXE

  ■ Free ALLFAX utility!  This program will send the entire contents of a

  ────────────────────────────────────────────────────────────────────────────
  Page 3

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

    message base you define to a phone number you define.  See ALLFAX.EXE

  ■ Free READMSG utility!  This is a standalone PCB 14.x message base reader.
    Primitive, but it works.  See READMSG.EXE

  ■ Free ENTMSG utility!  It's kinda like Text to Message, only very primitive.
    See ENTMSG.EXE

  ■ Support for an Echoed Fax Message Base among participating systems in
    a mail network.  Any BBS in the network that has a Fax Card should have
    a unique BBS.ID which users from other BBS's in the network can use to
    have faxes handled by the remote fax port.  See INTER-CITY FAXING

  ■ You decide which message base should be scanned on the Command Line.
    See COMMAND LINE SWITCHES

  ■ EchoFax uses a short canned Cover Letter but you customize the cover
    letter very easily!  See ECHOFAX.PGE

  ■ To handle Long Distance faxing, EchoFax reads a User File and checks to
    see if you have given the user Long Distance faxing credits.  A program
    is provided to maintain this User File.  See EFUSER.EXE

  ■ Support for verifying local prefixes.  You simply create a text file
    containing all of the local prefixes, one per line.  See ECHOFAX.PRE

  ■ Allows you to use an Alias as the phone number which EchoFax will then
    replace with a phone number.  See ECHOFAX.ALI

  ┌─────────────────────────────────────────────────────────────────────────┐
  │                        How to Install EchoFax                           │
  └─────────────────────────────────────────────────────────────────────────┘

  First Time Installation
  ──────────────────────────────────────────────────────────────────────────
  Create at least one new conference in PCBoard to handle your LOCAL fax
  requests.  If you are going to participate in an Echoed Message Base you
  should create a separate conference for that too.  Do this in PCBSETUP.
  It's up to you to decide if you will force all messages to be Receiver Only
  but it's a good idea.

  Installing Bitfax
  ──────────────────────────────────────────────────────────────────────────
  If you haven't already installed Bitfax you should do that now.  I followed
  the instructions in the BitFax manual when installing the software and
  suggest you do the same.  Make a subdirectory called BITFAX on your drive,
  change to the subdirectory, and copy the contents of the BitFax/SR Program
  disks into the subdirectory.  You should put SET BITFAX=C:\BITFAX in your
  AUTOEXEC.BAT file and include the BITFAX subdirectory in your PATH statement.
  (If you installed Bitfax into a different drive and subdirectory change the
  SET BITFAX= to conform).

  ────────────────────────────────────────────────────────────────────────────
  Page 4

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────


  Be sure to set your com port correctly on the fax card.

  Once your card is installed and your software is loaded onto the hard
  drive you should type BITFAX and set up the BitFax parameters.  Please
  follow the BitFax manual.  Their manual contains step by step instructions.
  I'd suggest you set the speaker OFF as it is quite noisy!

  Installing Text-To-Message
  ──────────────────────────────────────────────────────────────────────────
  If you are going to use the Inter-City fax capabilities of EchoFax then
  you will need a recent copy of Text To Message.  Place the file TXT2MSG.EXE
  in a subdirectory in your PATH= statement.

  Installing EchoFax
  ──────────────────────────────────────────────────────────────────────────
  Copy all of the files from the EchoFax ZIP into the same directory you
  installed Bitfax.

  Edit and/or Create the following files, depending on what options you wish
  to set up at this time, in the same directory you placed Bitfax and EchoFax:

  ECHOFAX.PGE --> OPTIONAL file you can create that will be included on
                  the Cover Letter.  Up to 51 lines please.  I've included
                  a nice sample with this package that currently displays my
                  BBS name.  You can Edit this file or simply Delete it.

  ECHOFAX.PRE --> OPTIONAL ASCII Text file, containing a list of all valid
                  dialing prefixes in your area, one prefix per line.  If
                  EchoFax finds this file, it will compare the prefix from
                  the number in the fax message against all entries in the
                  PRE file and look for match.  If there is no match, the
                  message will NOT be faxed out and the message will be
                  toggled as read and a message entered to the user saying the
                  prefix is not valid.  You will have to Create this file.

  ECHOFAX.ALI --> OPTIONAL file you can create containing a list of Alias
                  names that a user can place on line one of a message
                  instead of a phone number.  If EchoFax finds a match
                  between the Alias entered on line one and a line in
                  EchoFax.Ali then EchoFax will insert the phone number
                  that goes along with the Alias.  The format is:

                  CFMX,372-1625
                  WILSON AUTOMOTIVE,372-1625
                  YOUR COMPANY NAME,1-416-111-1111

  NUMBERS.FRE --> OPTIONAL file you can create containing a list of Long
                  Distance numbers any user can send a fax to.  Put one
                  number per line in this file without dashes.  For example,
                  14163721625 is a valid entry.  13721625 is also correct.

  ────────────────────────────────────────────────────────────────────────────
  Page 5

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

                  No dashes please (if you do the numbers will never match).

    USERS.FRE --> OPTIONAL file you can create containing a list of User Names
                  who may fax to Long Distance numbers no matter what.  Put one
                  name per line in this file.  This is not case sensitive.


  Upgrading to a Newer Release of EchoFax
  ──────────────────────────────────────────────────────────────────────────
  Unzip your newer EchoFax ZIP into a temporary directory and read over the
  file CHANGES.DOC.  You will need to replace the EchoFax.Exe file with the
  new one and possibly edit your batch files at a minimum.  As additional
  features are added you may need to Edit or Create other files as needed.


  Starting EchoFax
  ──────────────────────────────────────────────────────────────────────────
  You must run EchoFax using a Batch File we've provided.  This batch file
  allows EchoFax to completely drop out of memory, call up Bitfax and reload.
  You can run EchoFax in any number of ways from your EVENT.SYS, $$LOGOFF.BAT
  or BOARD.BAT.

  A typical example of how to execute EchoFax from your EVENT.SYS would be:

        CD\BITFAX
        CALL DOFAX /mL:\MSGS\FAX               <-- Local Conference
        CALL DOFAX /mL:\MSGS\E-FAX /idPHANTOM  <-- Echoed Conference

  You could also run EchoFax in your $$LOGOFF.BAT.  Your batch file may look
  something like this:

        ECHO OFF
        CD\BITFAX
        CALL DOFAX /mL:\MSGS\FAX               <-- Local Conference
        CALL DOFAX /mL:\MSGS\E-FAX /idPHANTOM  <-- Echoed Conference
        CD\PCB

  If low memory is a problem you could also call up EchoFax in your BOARD.BAT
  file.  You will have to go into PCBSETUP and set PCBoard to Exit To Dos After
  Each Call.  Then create a batch file to invoke EchoFax.  Let's call this
  ECHOFAX.BAT which may look like this:

        ECHO OFF
        CD\BITFAX
        CALL DOFAX /mL:\MSGS\FAX               <-- Local Conference
        CALL DOFAX /mL:\MSGS\E-FAX /idPHANTOM  <-- Echoed Conference
        CD\PCB
        BOARD

  You'll need to edit your BOARD.BAT file and insert the following line right
  after PCB145

  ────────────────────────────────────────────────────────────────────────────
  Page 6

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────


        PCB145
        IF ERRORLEVEL 5 ECHOFAX

  Be sure to place DOFAX.BAT in your BITFAX directory.  The contents of
  DOFAX.BAT are as follows:

        ECHO OFF
        SET TXT2MSG=-e
        :START
        ECHOFAX %1 %2 %3
        IF EXIST DOFAXE.YES CALL FAXE
        IF EXIST DOTXT.YES CALL DOTXT
        IF EXIST ECHOFAX.END GOTO END
        GOTO START
        :END

  DOFAXE.YES, FAXE.BAT, DOTXT.YES and DOTXT.BAT are created by EchoFax, and
  are used as key files to cycle into BitFax and eventually end.  Be sure to
  pass on the full drive, path and name of the message base in your batch
  file.  You may rename this Batch File to whatever name you desire.

  Command Line Switches
  ───────────────────────────────────────────────────────────────────────────
  To customize EchoFax for your needs the following Command Line Switches
  are available.  These switches should be on the line used in your batch
  file that calls up EchoFax, which out of the bag is DOFAX.BAT.


                                   /m

  EchoFax requires, at a minimum, the full path and name of the message base
  you want to scan for outgoing fax messages.  The /m parameter is used to
  define this information.  Case does not matter but it's easier to read if
  you put the switch in lower case and the details in upper case.  There is
  no space between the /m and the path to your message base.

  i.e.    CALL DOFAX /mC:\MSGS\FAX               <-- Local Fax Conference



                                  /id

  If you are a fax port in an Echoed Message Base then at a minimum, the full
  path and name of the message base you want to scan for outgoing fax messages
  is required and your BBS.ID.

  i.e.    CALL DOFAX /mC:\MSGS\E-FAX /idPHANTOM  <-- Echoed Fax Conference




  ────────────────────────────────────────────────────────────────────────────
  Page 7

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

                                   /l

  If your copy of Bitfax creates a log file called BITFAX.LOG instead of
  BITFAXTX.LOG then you'll need to add this command line switch and include
  the name of your log file.

  i.e.    CALL DOFAX /mC:\MSGS\FAX /lBITFAX.LOG

  There!  Installation is complete and you are ready to enter messages!



  ┌─────────────────────────────────────────────────────────────────────────┐
  │                      How to enter a Fax Message                         │
  └─────────────────────────────────────────────────────────────────────────┘

  In your LOCAL fax conference, EchoFax requires your users to enter messages
  with a SUBJECT of "FAX" and put the phone number on the first line of the
  message.  Line 2 and beyond will hold the content of the fax.  How many
  lines the user can use has been previously defined by you in PCBSETUP
  under the Maximum Number of Lines allowed in a message.  If you create
  and maintain the ECHOFAX.ALI file your users can enter a Name instead of
  an actual phone number.  If the name a user enters on the first line
  matches a name in the ECHOFAX.ALI file EchoFax will replace the name with
  the phone number.  I'd suggest creating a bulletin in your Fax conference
  so your users will know which alias is available.

  In your ECHOED fax conference, EchoFax requires your users to enter messages
  with a SUBJECT of "FAX VIA BBS.ID" and put the phone number on the first line
  of the message.  Line 2 and beyond will hold the content of the fax.  It is
  advisable to check with the participating BBS systems in your echo to verify
  the maximum number of lines allowed in a message.


  ┌─────────────────────────────────────────────────────────────────────────┐
  │                        Files used by EchoFax                            │
  └─────────────────────────────────────────────────────────────────────────┘

  ECHOFAX.EXE --> The heart of our system.  This program and supporting data
                  files should be placed in your \BITFAX subdirectory.

  ECHOFAX.END --> Created by EchoFax when the program has completed its work.
                  This is the key file that signals the end.  EchoFax will
                  delete ECHOFAX.END when it first loads so you don't have to
                  worry about it.  ECHOFAX.END will contain the date and time
                  of when EchoFax completed its work.

  ECHOFAX.LOG --> This is a LOG file appended to by EchoFax.  This log file
                  will contain a list of everything EchoFax did during its
                  run.  Message numbers fax, killed or toggled as Read will
                  appear in the Log.  Any Errors will also show up here.

  ────────────────────────────────────────────────────────────────────────────
  Page 8

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

                  It would be a good idea to read this file on a regular
                  basis.  Since EchoFax appends to it, you may want to delete
                  it or archive it on a regular basis as well.

  ECHOFAX.USR --> User File containing a list of names and number of credits
                  that you've assigned using EFUSER.EXE.  This is a Random
                  Access File with a length of 27.  UserName is 25 and the
                  number of credits is 2.  This file should be maintained by
                  EFUSER.  This is NOT compatible with Fax-Door.


  ┌─────────────────────────────────────────────────────────────────────────┐
  │                       Auxillary Files Included                          │
  └─────────────────────────────────────────────────────────────────────────┘

   EFUSER.EXE --> USER EDITOR for EchoFax.  If you wish to give a User access
                  to Long Distance faxing, use this program to Add/Edit their
                  account and place any number of "credits" for use.  Remember
                  that your users are going to be charged 2 credits for every
                  fax as the covering letter is included.  How much you charge
                  is up to you - I'd suggest $10.00 for 10 credits.  Remember
                  that you can let all users fax to a long distance of your
                  choice at no charge to them by using the NUMBERS.FRE file and
                  it is possible to let a user have global unlimited Long
                  Distance faxing abilities by including their name in the
                  USERS.FRE file.  These two files were discussed earlier in
                  the Installation section.

  ──────────────────────────────────────────────────────────────────────────

  MSGFLAG.EXE --> PURPOSE:  To adjust the Read Security of a message base.

                  MSGFLAG /M<MsgBase> [/ALL or /UFirst_Last]  [/PRI or /PUB]

                  Which means:

                  /M is the full location of the message base to work with

                  /ALL lets you change EVERY message, or;
                  /UFirst_Last lets you change messages TO or FROM a specific
                   user

                  /PRI lets you make those message Private, or;
                  /PUB lets you make those message Public.

  ──────────────────────────────────────────────────────────────────────────

  ALLFAX.EXE -->  PURPOSE:  To fax the entire contents of a message base to a
                  fax machine.

                  Type at DOS;  ALLFAX /Md:\path\msgbase /Pphone_number

  ────────────────────────────────────────────────────────────────────────────
  Page 9

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

                                MSGFAX

                  In a batch file enter;
                                ALLFAX /Md:\path\msgbase /Pphone_number
                                CALL MSGFAX.BAT

                  Once ALLFAX.EXE creates the necessary files for Bitfax, you
                  should then call up the MSGFAX.BAT file which is created by
                  ALLFAX.

                  ALLFAX.PGE is an optional addition to the canned cover page.
                  This is a simple ASCII file that you can create to add your
                  own customized look to the cover page.  The canned cover page
                  is pretty brief.

  ──────────────────────────────────────────────────────────────────────────

  READMSG.EXE --> This is an offline message base reader that you can use to
                  read your message bases outside of PCBoard.  The commands
                  are very basic and need little or no explaination.  You
                  cannot enter a message or edit a message, but you can edit
                  message headers, or Kill messages.  This is just something
                  I through together one day and isn't meant to be a full
                  blown mail reader.

  ──────────────────────────────────────────────────────────────────────────

  ENTMSG.EXE -->  This was the toy I created to test my Enter Message part
                  of EchoFax.  It is very primitive and only allows for
                  messages up to 128 bytes!

         Usage:  ENTMSG /TO<TO_NAME> /FR<FROM_NAME> /SUB<SUBJECT> /M<MSGBASE>

                 Type your message (Up to 128 characters) in a text file called
                 ENTMSG.TXT and run this program with the above switches.  If
                 you wish to start a new line you'll have to hold down your ALT
                 key and type the number 227.  So... your message becomes one
                 great big long sentence with this symbol π where you want a
                 new line.  I know, it sucks... but you might have a need for
                 it somewhere for quick oneline messsages.


  ┌─────────────────────────────────────────────────────────────────────────┐
  │                     Inter-City Faxing Explained                         │
  └─────────────────────────────────────────────────────────────────────────┘

  I'd create a LOCAL ONLY fax conference for YOUR users.  Fax messages will
  continue to be entered in the normal manner with the first three letters
  of the SUBJ: equalling "FAX" and a valid phone number on the first line.

  Then, I'd create another message base for ECHOED FAX MESSAGES.  In this

  ────────────────────────────────────────────────────────────────────────────
  Page 10

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

  conference messages to be faxed from another participating fax system
  should be placed with slightly different SUBJ: entries.  Inter-City
  Faxing is accomplished by the use of a BBS.ID in the SUBJ: line.  So
  let's look at a simple example.  A user on a BBS that doesn't have
  an outgoing fax service that is located in Cobourg wants to fax a message
  to a user in Toronto.  The User enters a message to his friend with
  a SUBJ: of "FAX VIA 1000BBS" and enters a phone number of 367-4915 on
  the first line of the message, and flags the message for Echoing.
  This message gets echoed out to the message bases of all systems
  participating in the Inter-City Fax Conference.  On my BBS I would call up
  Echofax with an ID of PHANTOM so my system, and any other system would
  ignore the message.  However, 1000BBS would handle the fax since the
  ID matches!  Any message from this echoed conference starting with just
  FAX will be ignored.  EchoFax will only send out messages with a full
  SUBJ: of "FAX VIA BBS.ID" (if called up using the BBS.ID option).

  If two conferences are set up, no duplicate faxing should occur.

  One other twist - if a message is successfully faxed from the echoed
  conference, EchoFax will enter a message to the user who entered the
  original fax message letting the user know that the message was sent
  out successfully!  Likewise, if the fax is unsuccessful a message will
  be echoed out as well.

  I would suggest each participating BBS create a NEWS file showing the
  BBS.IDs of the active Fax systems and their locations.  A user can
  join this conference and read the NEWS screen and locate a BBS that
  might be able to handle their fax.  This also means that an active
  fax system is capable of offering long distance faxing to a user who
  participates through a different BBS... remember, that when your local
  copy of EchoFax checks the phone number, it is found to be long distance
  your local copy of EchoFax will read through your EchoFax User File
  to check for Long Distance Credits!  How you handle this is totally up
  to you!


  ┌─────────────────────────────────────────────────────────────────────────┐
  │                               Support                                   │
  └─────────────────────────────────────────────────────────────────────────┘

  If you have suggestions for new options or are having difficulty setting
  up your copy of EchoFax the easiest place to find help is on my BBS.

  I post a "What's New With EchoFax" message in the EchoNet CanShare conference
  and in my Support Conference on my board when new work has been done.  You
  can message with me via EchoNet or NANET.

  At the moment there is no Shareware, crippled release of EchoFax.  However
  I am thinking about distributing a sample version of EchoFax to generate
  further interest.  Any suggestions?


  ────────────────────────────────────────────────────────────────────────────
  Page 11

                          EchoFax Sysop Documentation
  ────────────────────────────────────────────────────────────────────────────

  New copies of EchoFax can be found on my BBS *only* at this time.  Join the
  Support Conference (#9).  The filename is always the same so you can do a
  F V EFBETA.ZIP and compare file dates and times.  This file is also Password
  Protected.  You should have been told the password when you purchased this
  product.  If you've forgotten the password you will need to contact me
  voice or via the mail service.


  ┌─────────────────────────────────────────────────────────────────────────┐
  │                         How to Order Bitfax                             │
  └─────────────────────────────────────────────────────────────────────────┘

  Contact BIT Software, Inc.           BitFax for Windows $79.00 US
          47987 Fremont Blvd.          BitFax/SR for DOS  $50.00 US
          Fremont, CA  USA
          94538

          Phone [phone]
          Fax   [phone]


































  ────────────────────────────────────────────────────────────────────────────
  Page 12